Skip to content

Conversation

ericstj
Copy link
Member

@ericstj ericstj commented Oct 1, 2025

I discovered that our process for porting documentation from dotnet/runtime was incorrect. It mentioned to port from our final output, which didn't contain the source-authored docs for assemblies that didn't use /// as source of truth. This fixes that.

I tried to correct for all the problems we noticed in the first wave of changes so hopefully this is less work to correct.

@ericstj ericstj requested a review from a team as a code owner October 1, 2025 17:08
@github-actions github-actions bot added the area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable. label Oct 1, 2025
Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed through System.DirectoryServices.

@ericstj ericstj requested a review from gewarren October 2, 2025 18:29
@ericstj
Copy link
Member Author

ericstj commented Oct 2, 2025

I addressed feedback, tried to fix all formatting issues, and improve the formatting where I could.

@dotnet-policy-service dotnet-policy-service bot added the needs-author-action An issue or pull request that requires more info or actions from the author. label Oct 3, 2025
@Copilot Copilot AI review requested due to automatic review settings October 6, 2025 17:03
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR corrects the documentation porting process from dotnet/runtime for .NET 10, focusing on assemblies that don't use /// as the source of truth. The changes primarily address documentation improvements including fixing typos, adding missing documentation elements, and correcting formatting issues across multiple system libraries.

  • Fixed typo correction (e.g., "recieve" to "receive")
  • Added missing documentation for previously undocumented parameters and methods
  • Improved formatting and structure of existing documentation

Reviewed Changes

Copilot reviewed 175 out of 176 changed files in this pull request and generated no comments.

Show a summary per file
File Description
xml/index.xml Fixed malformed XML tag with extra character
xml/System/Uri.xml Added inheritdoc tag for ToString method
xml/System/Span`1+Enumerator.xml Added proper Current property documentation
xml/System/ReadOnlySpan`1+Enumerator.xml Added proper Current property documentation
xml/System/MemoryExtensions.xml Fixed formatting for return statements and exceptions
xml/System/BinaryData.xml Added comprehensive documentation for constructors and factory methods
xml/System.Xml/XmlProcessingInstruction.xml Added inheritdoc tags for interface implementations
xml/System.Threading/ThreadLocal`1.xml Added missing exception documentation
xml/System.Threading.Channels/Channel.xml Added exception documentation for channel creation methods
xml/System.Threading.Channels/BoundedChannelOptions.xml Added exception documentation for property setters
xml/System.Text/Rune.xml Added proper documentation for Parse method
xml/System.Text.RegularExpressions/Regex+ValueSplitEnumerator.xml Added inheritdoc tags
xml/System.Text.RegularExpressions/Regex+ValueMatchEnumerator.xml Added inheritdoc tags
xml/System.Text.Json/Utf8JsonWriter.xml Comprehensive documentation updates for various write methods
xml/System.Text.Json/JsonWriterOptions.xml Improved documentation formatting and clarity
xml/System.Text.Json/JsonSerializerOptions.xml Added extensive documentation for new properties
xml/System.Text.Json/JsonSerializerDefaults.xml Added summary for Strict enum value
xml/System.Text.Json/JsonSerializer.xml Added comprehensive documentation for async deserialization methods
xml/System.Text.Json/JsonReaderOptions.xml Improved documentation formatting
xml/System.Text.Json/JsonElement.xml Added extensive documentation for parsing and property access methods
xml/System.Text.Json/JsonElement+ObjectEnumerator.xml Added inheritdoc tag
xml/System.Text.Json/JsonElement+ArrayEnumerator.xml Added inheritdoc tag
xml/System.Text.Json/JsonDocumentOptions.xml Added property documentation
xml/System.Text.Json/JsonDocument.xml Added inheritdoc tag for Dispose
xml/System.Text.Json.Serialization/JsonStringEnumMemberNameAttribute.xml Added complete documentation
xml/System.Text.Json.Serialization/JsonSourceGenerationOptionsAttribute.xml Added property documentation
xml/System.Text.Json.Serialization/JsonKnownReferenceHandler.xml Added enum value documentation
xml/System.Text.Json.Serialization/JsonIgnoreCondition.xml Added enum value documentation
xml/System.Text.Json.Serialization/BinaryDataJsonConverter.xml Added constructor documentation
xml/System.Text.Json.Nodes/JsonValue.xml Added seealso reference
xml/System.Text.Json.Nodes/JsonObject.xml Added comprehensive method documentation
xml/System.Text.Json.Nodes/JsonNode.xml Added seealso references and improved formatting
xml/System.Text.Json.Nodes/JsonArray.xml Added method documentation with exception handling
xml/System.Security.Cryptography/*.xml Extensive documentation updates for cryptographic classes including ML-DSA, SLH-DSA, ML-KEM algorithms
xml/System.Security.Cryptography.X509Certificates/*.xml Added documentation for signature generators and certificate collections
Comments suppressed due to low confidence (11)

@ericstj ericstj removed the needs-author-action An issue or pull request that requires more info or actions from the author. label Oct 6, 2025
@ericstj ericstj merged commit d0d959c into dotnet:main Oct 6, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants